<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=US-ASCII">
<title>read_until (5 of 16 overloads)</title>
<link rel="stylesheet" href="../../../boostbook.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="../../../index.html" title="Asio">
<link rel="up" href="../read_until.html" title="read_until">
<link rel="prev" href="overload4.html" title="read_until (4 of 16 overloads)">
<link rel="next" href="overload6.html" title="read_until (6 of 16 overloads)">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table cellpadding="2" width="100%"><tr><td valign="top"><img alt="asio C++ library" width="250" height="60" src="../../../asio.png"></td></tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload4.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload6.html"><img src="../../../next.png" alt="Next"></a>
</div>
<div class="section">
<div class="titlepage"><div><div><h4 class="title">
<a name="asio.reference.read_until.overload5"></a><a class="link" href="overload5.html" title="read_until (5 of 16 overloads)">read_until (5
        of 16 overloads)</a>
</h4></div></div></div>
<p>
          Read data into a dynamic buffer sequence until some part of the data it
          contains matches a regular expression.
        </p>
<pre class="programlisting">template&lt;
    typename <a class="link" href="../SyncReadStream.html" title="Buffer-oriented synchronous read stream requirements">SyncReadStream</a>,
    typename <a class="link" href="../DynamicBuffer.html" title="Dynamic buffer requirements">DynamicBuffer</a>&gt;
std::size_t read_until(
    SyncReadStream &amp; s,
    DynamicBuffer &amp;&amp; buffers,
    const boost::regex &amp; expr);
</pre>
<p>
          This function is used to read data into the specified dynamic buffer sequence
          until the dynamic buffer sequence's get area contains some data that matches
          a regular expression. The call will block until one of the following conditions
          is true:
        </p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
              A substring of the dynamic buffer sequence's get area matches the regular
              expression.
            </li>
<li class="listitem">
              An error occurred.
            </li>
</ul></div>
<p>
          This operation is implemented in terms of zero or more calls to the stream's
          read_some function. If the dynamic buffer sequence's get area already contains
          data that matches the regular expression, the function returns immediately.
        </p>
<h6>
<a name="asio.reference.read_until.overload5.h0"></a>
          <span><a name="asio.reference.read_until.overload5.parameters"></a></span><a class="link" href="overload5.html#asio.reference.read_until.overload5.parameters">Parameters</a>
        </h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">s</span></dt>
<dd><p>
                The stream from which the data is to be read. The type must support
                the SyncReadStream concept.
              </p></dd>
<dt><span class="term">buffers</span></dt>
<dd><p>
                A dynamic buffer sequence into which the data will be read.
              </p></dd>
<dt><span class="term">expr</span></dt>
<dd><p>
                The regular expression.
              </p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.read_until.overload5.h1"></a>
          <span><a name="asio.reference.read_until.overload5.return_value"></a></span><a class="link" href="overload5.html#asio.reference.read_until.overload5.return_value">Return
          Value</a>
        </h6>
<p>
          The number of bytes in the dynamic buffer sequence's get area up to and
          including the substring that matches the regular expression.
        </p>
<h6>
<a name="asio.reference.read_until.overload5.h2"></a>
          <span><a name="asio.reference.read_until.overload5.exceptions"></a></span><a class="link" href="overload5.html#asio.reference.read_until.overload5.exceptions">Exceptions</a>
        </h6>
<div class="variablelist">
<p class="title"><b></b></p>
<dl>
<dt><span class="term">asio::system_error</span></dt>
<dd><p>
                Thrown on failure.
              </p></dd>
</dl>
</div>
<h6>
<a name="asio.reference.read_until.overload5.h3"></a>
          <span><a name="asio.reference.read_until.overload5.remarks"></a></span><a class="link" href="overload5.html#asio.reference.read_until.overload5.remarks">Remarks</a>
        </h6>
<p>
          After a successful read_until operation, the dynamic buffer sequence may
          contain additional data beyond that which matched the regular expression.
          An application will typically leave that data in the dynamic buffer sequence
          for a subsequent read_until operation to examine.
        </p>
<h6>
<a name="asio.reference.read_until.overload5.h4"></a>
          <span><a name="asio.reference.read_until.overload5.example"></a></span><a class="link" href="overload5.html#asio.reference.read_until.overload5.example">Example</a>
        </h6>
<p>
          To read data into a <code class="computeroutput">std::string</code> until a CR-LF sequence is
          encountered:
        </p>
<pre class="programlisting">std::string data;
std::string n = asio::read_until(s,
    asio::dynamic_buffer(data), boost::regex("\r\n"));
std::string line = data.substr(0, n);
data.erase(0, n);
</pre>
<p>
          After the <code class="computeroutput">read_until</code> operation completes successfully, the
          string <code class="computeroutput">data</code> contains the delimiter:
        </p>
<pre class="programlisting">{ 'a', 'b', ..., 'c', '\r', '\n', 'd', 'e', ... }
</pre>
<p>
          The call to <code class="computeroutput">substr</code> then extracts the data up to and including
          the delimiter, so that the string <code class="computeroutput">line</code> contains:
        </p>
<pre class="programlisting">{ 'a', 'b', ..., 'c', '\r', '\n' }
</pre>
<p>
          After the call to <code class="computeroutput">erase</code>, the remaining data is left in the
          buffer <code class="computeroutput">b</code> as follows:
        </p>
<pre class="programlisting">{ 'd', 'e', ... }
</pre>
<p>
          This data may be the start of a new line, to be extracted by a subsequent
          <code class="computeroutput">read_until</code> operation.
        </p>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
<td align="left"></td>
<td align="right"><div class="copyright-footer">Copyright &#169; 2003-2018 Christopher M. Kohlhoff<p>
        Distributed under the Boost Software License, Version 1.0. (See accompanying
        file LICENSE_1_0.txt or copy at <a href="http://www.boost.org/LICENSE_1_0.txt" target="_top">http://www.boost.org/LICENSE_1_0.txt</a>)
      </p>
</div></td>
</tr></table>
<hr>
<div class="spirit-nav">
<a accesskey="p" href="overload4.html"><img src="../../../prev.png" alt="Prev"></a><a accesskey="u" href="../read_until.html"><img src="../../../up.png" alt="Up"></a><a accesskey="h" href="../../../index.html"><img src="../../../home.png" alt="Home"></a><a accesskey="n" href="overload6.html"><img src="../../../next.png" alt="Next"></a>
</div>
</body>
</html>
